FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.7.16  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.patient-corrections#current (31 ms)

Package hl7.fhir.uv.patient-corrections
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/patient-corrections/https://build.fhir.org/ig/HL7/fhir-patient-correction/CapabilityStatement-PatientCorrectionCapability.html
Url http://hl7.org/fhir/uv/patient-corrections/CapabilityStatement/PatientCorrectionCapability
Version 1.0.0
Status active
Date 2022-03-04
Name PatientCorrectionCapability
Title Patient Request for Corrections Capability Statement
Experimental False
Realm uv
Authority hl7
Description Describes the capabilities for a FHIR server to support patient requests for corrections.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement PatientCorrectionCapability

Patient Request for Corrections Capability Statement

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2022-03-04
  • Published by: HL7 International / Patient Empowerment

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

  • https://hl7.org/fhir/uv/patient-corrections

FHIR RESTful Capabilities

Mode: server

Description of the needed resources to be supported by the FHIR server, and the different possible interactions.

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the search-systeminteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Communication yyabout
Task yyreasonReference
Bundle y

Resource Conformance: SHALL Communication

Core FHIR Resource
Communication
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a communication between a patient and a fulfiller relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLaboutreference

Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about.

 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Documentation

Read a Task relating to a patient correction request.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLreasonReferencereference

For Disagreement Tasks, search for the original request for correction Communication.

 

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • SHALL support read.

Documentation

Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.


Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "PatientCorrectionCapability",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement PatientCorrectionCapability</b></p><a name=\"PatientCorrectionCapability\"> </a><a name=\"hcPatientCorrectionCapability\"> </a><a name=\"PatientCorrectionCapability-en-US\"> </a><h2 id=\"title\">Patient Request for Corrections Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-03-04 </li><li>Published by: HL7 International / Patient Empowerment </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>https://hl7.org/fhir/uv/patient-corrections</li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Description of the needed resources to be supported by the FHIR server, and the different possible interactions.</p>\n</div><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li><li>Supports the <code>search-system</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Communication1-1\">Communication</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>about</td><td/><td/><td/></tr><tr><td><a href=\"#Task1-2\">Task</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>reasonReference</td><td/><td/><td/></tr><tr><td><a href=\"#Bundle1-3\">Bundle</a></td><td>�</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Communication1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Communication</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/communication.html\">Communication</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Read a communication between a patient and a fulfiller relating to a patient correction request.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>about</td><td><code>reference</code></td><td><div><p>Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Task1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Task</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/task.html\">Task</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Read a Task relating to a patient correction request.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>reasonReference</td><td><code>reference</code></td><td><div><p>For Disagreement Tasks, search for the original request for correction Communication.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>.</li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.</p>\n</div></blockquote></div></div></div></div></div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pe"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/patient-corrections/ImplementationGuide/hl7.fhir.uv.patient-corrections"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/patient-corrections/ImplementationGuide/hl7.fhir.uv.patient-corrections"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/patient-corrections/CapabilityStatement/PatientCorrectionCapability",
  "version" : "1.0.0",
  "name" : "PatientCorrectionCapability",
  "title" : "Patient Request for Corrections Capability Statement",
  "status" : "active",
  "date" : "2022-03-04",
  "publisher" : "HL7 International / Patient Empowerment",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/patientempowerment"
        }
      ]
    },
    {
      "name" : "Virginia Lorenzi",
      "telecom" : [
        {
          "system" : "email",
          "value" : "vlorenzi@nyp.org"
        }
      ]
    },
    {
      "name" : "David Pyke",
      "telecom" : [
        {
          "system" : "email",
          "value" : "david@pyke.ca"
        }
      ]
    }
  ],
  "description" : "Describes the capabilities for a FHIR server to support patient requests for corrections.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "implementationGuide" : [
    "https://hl7.org/fhir/uv/patient-corrections"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "Description of the needed resources to be supported by the FHIR server, and the different possible interactions.",
      "resource" : [
        {
          "type" : "Communication",
          "documentation" : "Read a communication between a patient and a fulfiller relating to a patient correction request.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "about",
              "type" : "reference",
              "documentation" : "Search for PatientCorrectionTask or PatientCorrectionCommunication this PatientCorrectionCommunication is about."
            }
          ]
        },
        {
          "type" : "Task",
          "documentation" : "Read a Task relating to a patient correction request.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "reasonReference",
              "type" : "reference",
              "documentation" : "For Disagreement Tasks, search for the original request for correction Communication."
            }
          ]
        },
        {
          "type" : "Bundle",
          "documentation" : "Read a Patient Correction Bundle which contains a Patient Correction Communication and related resources.",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            }
          ]
        }
      ],
      "interaction" : [
        {
          "code" : "transaction"
        },
        {
          "code" : "search-system"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.